home *** CD-ROM | disk | FTP | other *** search
/ Mac Easy 2010 May / Mac Life Ubuntu.iso / casper / filesystem.squashfs / usr / share / hplip / scan / sane.py < prev    next >
Encoding:
Python Source  |  2009-04-14  |  21.5 KB  |  628 lines
  1. # -*- coding: utf-8 -*-
  2. #
  3. # (c) Copyright 2003-2008 Hewlett-Packard Development Company, L.P.
  4. #
  5. # This program is free software; you can redistribute it and/or modify
  6. # it under the terms of the GNU General Public License as published by
  7. # the Free Software Foundation; either version 2 of the License, or
  8. # (at your option) any later version.
  9. #
  10. # This program is distributed in the hope that it will be useful,
  11. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  12. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13. # GNU General Public License for more details.
  14. #
  15. # You should have received a copy of the GNU General Public License
  16. # along with this program; if not, write to the Free Software
  17. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  18. #
  19. # Based on:
  20. # "sane.py", part of the Python Imaging Library (PIL)
  21. # http://www.pythonware.com/products/pil/
  22. # Python wrapper on top of the _sane module, which is in turn a very
  23. # thin wrapper on top of the SANE library.  For a complete understanding
  24. # of SANE, consult the documentation at the SANE home page:
  25. # http://www.mostang.com/sane/ .#
  26. #
  27. # Modified to work without PIL by Don Welch
  28. # 
  29. # (C) Copyright 2003 A.M. Kuchling.  All Rights Reserved
  30. # (C) Copyright 2004 A.M. Kuchling, Ralph Heinkel  All Rights Reserved
  31. #
  32. # Permission to use, copy, modify, and distribute this software and its
  33. # documentation for any purpose and without fee is hereby granted,
  34. # provided that the above copyright notice appear in all copies and that
  35. # both that copyright notice and this permission notice appear in
  36. # supporting documentation, and that the name of A.M. Kuchling and
  37. # Ralph Heinkel not be used in advertising or publicity pertaining to 
  38. # distribution of the software without specific, written prior permission.
  39. # 
  40. # A.M. KUCHLING, R.H. HEINKEL DISCLAIM ALL WARRANTIES WITH REGARD TO THIS 
  41. # SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS,
  42. # IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  43. # CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF
  44. # USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
  45. # OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  46. # PERFORMANCE OF THIS SOFTWARE.
  47. # Python wrapper on top of the scanext module, which is in turn a very
  48. # thin wrapper on top of the SANE library.  For a complete understanding
  49. # of SANE, consult the documentation at the SANE home page:
  50. # http://www.mostang.com/sane/ .
  51. #
  52. # Original authors: Andrew Kuchling, Ralph Heinkel
  53. # Modified by: Don Welch
  54. #
  55.  
  56. # Std Lib
  57. import scanext
  58. import threading
  59. import time
  60. import os
  61. import Queue
  62.  
  63. # Local
  64. from base.g import *
  65. from base import utils
  66.  
  67. EVENT_SCAN_CANCELED = 1
  68.  
  69. TYPE_STR = { scanext.TYPE_BOOL:   "TYPE_BOOL",   scanext.TYPE_INT:    "TYPE_INT",
  70.              scanext.TYPE_FIXED:  "TYPE_FIXED",  scanext.TYPE_STRING: "TYPE_STRING",
  71.              scanext.TYPE_BUTTON: "TYPE_BUTTON", scanext.TYPE_GROUP:  "TYPE_GROUP" }
  72.  
  73. UNIT_STR = { scanext.UNIT_NONE:        "UNIT_NONE",
  74.              scanext.UNIT_PIXEL:       "UNIT_PIXEL",
  75.              scanext.UNIT_BIT:         "UNIT_BIT",
  76.              scanext.UNIT_MM:          "UNIT_MM",
  77.              scanext.UNIT_DPI:         "UNIT_DPI",
  78.              scanext.UNIT_PERCENT:     "UNIT_PERCENT",
  79.              scanext.UNIT_MICROSECOND: "UNIT_MICROSECOND" }
  80.  
  81.  
  82. class Option:
  83.     """Class representing a SANE option.
  84.     Attributes:
  85.     index -- number from 0 to n, giving the option number
  86.     name -- a string uniquely identifying the option
  87.     title -- single-line string containing a title for the option
  88.     desc -- a long string describing the option; useful as a help message
  89.     type -- type of this option.  Possible values: TYPE_BOOL,
  90.             TYPE_INT, TYPE_STRING, and so forth.
  91.     unit -- units of this option.  Possible values: UNIT_NONE,
  92.             UNIT_PIXEL, etc.
  93.     size -- size of the value in bytes
  94.     cap -- capabilities available; CAP_EMULATED, CAP_SOFT_SELECT, etc.
  95.     constraint -- constraint on values.  Possible values:
  96.         None : No constraint
  97.         (min,max,step)  Integer values, from min to max, stepping by
  98.         list of integers or strings: only the listed values are allowed
  99.     """
  100.  
  101.     def __init__(self, args, cur_device):
  102.         import string
  103.         self.cur_device = cur_device
  104.         
  105.         self.index, self.name, self.title, self.desc, self.type, \
  106.             self.unit, self.size, self.cap, self.constraint = args
  107.         
  108.         if type(self.name) != type(''): 
  109.             self.name = str(self.name)
  110.             
  111.     def isActive(self):
  112.         return scanext.isOptionActive(self.cap)
  113.         
  114.     def isSettable(self):
  115.         return scanext.isOptionSettable(self.cap)
  116.         
  117.     def __repr__(self):
  118.         if self.isSettable():
  119.             settable = 'yes'
  120.         else:
  121.             settable = 'no'
  122.         
  123.         if self.isActive():
  124.             active = 'yes'
  125.             curValue = self.cur_device.getOption(self.name)
  126.         else:
  127.             active = 'no'
  128.             curValue = '<not available, inactive option>'
  129.             
  130.         
  131.         return """\nName:      %s
  132. Cur value: %s
  133. Index:     %d
  134. Title:     %s
  135. Desc:      %s
  136. Type:      %s
  137. Unit:      %s
  138. Constr:    %s
  139. isActive:    %s
  140. isSettable:  %s\n""" % (self.name, curValue,
  141.                       self.index, self.title, self.desc,
  142.                       TYPE_STR[self.type], UNIT_STR[self.unit],
  143.                       self.constraint, active, settable)
  144.         return s
  145.         
  146.     def limitAndSet(self, value):
  147.         if value is not None and self.constraint is not None:
  148.             if type(self.constraint) == type(()):
  149.                 if value < self.constraint[0]:
  150.                     value = self.constraint[0]
  151.                     log.warn("Invalid value for %s (%s < min value of %d). Using %d." % 
  152.                         (self.name, self.name, value, value))
  153.                 
  154.                 elif value > self.constraint[1]:
  155.                     value = self.constraint[1]
  156.                     log.warn("Invalid value for %s (%s > max value of %d). Using %d." % 
  157.                         (self.name, self.name, value, value))
  158.                     
  159.                 self.cur_device.setOption(self.name, value)
  160.             
  161.             elif type(self.constraint) == type([]):
  162.                 if value not in self.constraint:
  163.                     v = self.constraint[0]
  164.                     min_dist = sys.maxint
  165.                     for x in self.constraint: 
  166.                         if abs(value-x) < min_dist:
  167.                             min_dist = abs(value-x)
  168.                             v = x
  169.                             
  170.                     log.warn("Invalid value for %s (%s not in constraint list: %s). Using %d." % 
  171.                         (self.name, self.name, value, ', '.join(self.constraint), v))
  172.                         
  173.                     self.cur_device.setOption(self.name, v)
  174.         
  175.         else:
  176.             value = self.cur_device.getOption(self.name)
  177.             
  178.         return value
  179.  
  180.  
  181. ##class _SaneIterator:
  182. ##    """ intended for ADF scans.
  183. ##    """
  184. ##
  185. ##    def __init__(self, cur_device):
  186. ##        self.cur_device = cur_device
  187. ##
  188. ##    def __iter__(self):
  189. ##        return self
  190. ##
  191. ##    def __del__(self):
  192. ##        self.cur_device.cancelScan()
  193. ##
  194. ##    def next(self):
  195. ##        try:
  196. ##            self.cur_device.startScan()
  197. ##        except error, v:
  198. ##            if v == 'Document feeder out of documents':
  199. ##                raise StopIteration
  200. ##            else:
  201. ##                raise
  202. ##        return self.cur_device.performScan(1)
  203.         
  204.  
  205.  
  206.  
  207. class ScanDevice:
  208.     """Class representing a SANE device.
  209.     Methods:
  210.     startScan()    -- initiate a scan, using the current settings
  211.     cancelScan()   -- cancel an in-progress scanning operation
  212.  
  213.     Also available, but rather low-level:
  214.     getParameters() -- get the current parameter settings of the device
  215.     getOptions()    -- return a list of tuples describing all the options.
  216.  
  217.     Attributes:
  218.     optlist -- list of option names
  219.  
  220.     You can also access an option name to retrieve its value, and to
  221.     set it.  For example, if one option has a .name attribute of
  222.     imagemode, and scanner is a ScanDevice object, you can do:
  223.          print scanner.imagemode
  224.          scanner.imagemode = 'Full frame'
  225.          scanner.['imagemode'] returns the corresponding Option object.
  226.     """
  227.     
  228.     def __init__(self, dev):
  229.         self.scan_thread = None
  230.         self.dev = scanext.openDevice(dev)
  231.         self.options = {}
  232.         self.__load_options_dict()
  233.  
  234.  
  235.     def __load_options_dict(self):
  236.         opts = self.options
  237.         opt_list = self.dev.getOptions()
  238.         
  239.         for t in opt_list:
  240.             o = Option(t, self)
  241.             
  242.             if o.type != scanext.TYPE_GROUP:
  243.                 opts[o.name] = o
  244.  
  245.  
  246.     def setOption(self, key, value):
  247.         opts = self.options
  248.         
  249.         if key not in opts:
  250.             opts[key] = value
  251.             return
  252.         
  253.         opt = opts[key]
  254.         
  255.         if opt.type == scanext.TYPE_GROUP:
  256.             log.error("Groups can't be set: %s" % key)
  257.         
  258.         if not scanext.isOptionActive(opt.cap):
  259.             log.error("Inactive option: %s" % key)
  260.         
  261.         if not scanext.isOptionSettable(opt.cap):
  262.             log.error("Option can't be set by software: %s" % key)
  263.         
  264.         if type(value) == int and opt.type == scanext.TYPE_FIXED:
  265.             # avoid annoying errors of backend if int is given instead float:
  266.             value = float(value)
  267.         
  268.         try:
  269.             self.last_opt = self.dev.setOption(opt.index, value)
  270.         except scanext.error:
  271.             log.error("Unable to set option %s to value %s" % (key, value))
  272.         
  273.         # do binary AND to find if we have to reload options:
  274.         if self.last_opt & scanext.INFO_RELOAD_OPTIONS:
  275.             self.__load_options_dict()
  276.             
  277.  
  278.     def getOption(self, key):
  279.         opts = self.options
  280.         
  281.         if key == 'optlist':
  282.             return opts.keys()
  283.         
  284.         if key == 'area':
  285.             return (opts["tl-x"], opts["tl-y"]), (opts["br-x"], opts["br-y"])
  286.         
  287.         if key not in opts:
  288.             raise AttributeError, 'No such attribute: %s' % key
  289.         
  290.         opt = opts[key]
  291.         
  292.         if opt.type == scanext.TYPE_BUTTON:
  293.             raise AttributeError, "Buttons don't have values: %s" % key
  294.         
  295.         if opt.type == scanext.TYPE_GROUP:
  296.             raise AttributeError, "Groups don't have values: %s " % key
  297.         
  298.         if not scanext.isOptionActive(opt.cap):
  299.             raise AttributeError, 'Inactive option: %s' % key
  300.         
  301.         return self.dev.getOption(opt.index)
  302.  
  303.  
  304.     def getOptionObj(self, key):
  305.         opts = self.options
  306.         if key in opts:
  307.             return opts[key]
  308.         
  309.  
  310.     def getParameters(self):
  311.         """Return a 6-tuple holding all the current device settings:
  312.            (format, format_name, last_frame, (pixels_per_line, lines), depth, bytes_per_line)
  313.         
  314.             - format is the SANE frame type
  315.             - format is one of 'grey', 'color' (RGB), 'red', 'green', 'blue'.
  316.             - last_frame [bool] indicates if this is the last frame of a multi frame image
  317.             - (pixels_per_line, lines) specifies the size of the scanned image (x,y)
  318.             - lines denotes the number of scanlines per frame
  319.             - depth gives number of pixels per sample
  320.         """
  321.         return self.dev.getParameters()
  322.  
  323.  
  324.     def getOptions(self):
  325.         "Return a list of tuples describing all the available options"
  326.         return self.dev.getOptions()
  327.         
  328.         
  329.     def startScan(self, byte_format='BGRA', update_queue=None, event_queue=None):
  330.         """
  331.             Perform a scan with the current device.
  332.             Calls sane_start().
  333.         """
  334.         if not self.isScanActive():
  335.             status = self.dev.startScan()
  336.             self.format, self.format_name, self.last_frame, self.pixels_per_line, \
  337.             self.lines, self.depth, self.bytes_per_line = self.dev.getParameters()
  338.             
  339.             self.scan_thread = ScanThread(self.dev, byte_format, update_queue, event_queue)
  340.             self.scan_thread.scan_active = True
  341.             self.scan_thread.start()
  342.             return True, self.lines * self.bytes_per_line, status
  343.         else:
  344.             # Already active
  345.             return False, 0, scanext.SANE_STATUS_DEVICE_BUSY
  346.             
  347.             
  348.     def cancelScan(self):
  349.         "Cancel an in-progress scanning operation."
  350.         return self.dev.cancelScan()
  351.  
  352.  
  353.     def getScan(self):
  354.         "Get the output buffer and info about a completed scan."
  355.         if not self.isScanActive():
  356.             s = self.scan_thread
  357.             
  358.             return s.buffer, s.format, s.format_name, s.pixels_per_line, \
  359.                 s.lines, s.depth, s.bytes_per_line, s.pad_bytes, s.total_read
  360.                 
  361.                 
  362.     def freeScan(self):
  363.         "Cleanup the scan file after a completed scan."
  364.         if not self.isScanActive():
  365.             s = self.scan_thread
  366.             
  367.             try:
  368.                 s.buffer.close()
  369.                 os.remove(s.buffer_path)
  370.             except (IOError, AttributeError):
  371.                 pass
  372.         
  373.         
  374.     def isScanActive(self):
  375.         if self.scan_thread is not None:
  376.             return self.scan_thread.isAlive() and self.scan_thread.scan_active
  377.         else:
  378.             return False
  379.             
  380.             
  381.     def waitForScanDone(self):
  382.         if self.scan_thread is not None and \
  383.             self.scan_thread.isAlive() and \
  384.             self.scan_thread.scan_active:
  385.  
  386.             try:
  387.                 self.scan_thread.join()
  388.             except KeyboardInterrupt:
  389.                 pass
  390.                 
  391.                 
  392.     def waitForScanActive(self):
  393.         time.sleep(0.5)
  394.         if self.scan_thread is not None:
  395.             while True:
  396.                 #print self.scan_thread.isAlive()
  397.                 #print self.scan_thread.scan_active
  398.                 if self.scan_thread.isAlive() and \
  399.                     self.scan_thread.scan_active:
  400.                     return
  401.                 
  402.                 time.sleep(0.5)
  403.                 #print "Waiting..."
  404.         
  405.         
  406. ##    def scanMulti(self):
  407. ##        return _SaneIterator(self)
  408.         
  409.         
  410.     def closeScan(self):
  411.         "Close the SANE device after a scan."
  412.         self.dev.closeScan()
  413.  
  414.         
  415.         
  416. class ScanThread(threading.Thread):
  417.     def __init__(self, device, byte_format='BGRA', update_queue=None, event_queue=None):
  418.         threading.Thread.__init__(self)
  419.         self.scan_active = True
  420.         self.dev = device
  421.         self.update_queue = update_queue
  422.         self.event_queue = event_queue
  423.         self.buffer_fd, self.buffer_path = utils.make_temp_file(prefix='hpscan')
  424.         self.buffer = os.fdopen(self.buffer_fd, "w+b")
  425.         self.format = -1
  426.         self.format_name = ''
  427.         self.last_frame = -1
  428.         self.pixels_per_line = -1
  429.         self.lines = -1
  430.         self.depth = -1
  431.         self.bytes_per_line = -1
  432.         self.pad_bytes = -1
  433.         self.total_read = 0
  434.         self.byte_format = byte_format
  435.         
  436.         
  437.     def updateQueue(self, status, bytes_read):
  438.         if self.update_queue is not None:
  439.             try:
  440.                 status = int(status)
  441.             except (ValueError, TypeError):
  442.                 status = -1 #scanext.SANE_STATUS_GOOD
  443.                 
  444.             self.update_queue.put((status, bytes_read))
  445.             time.sleep(0)
  446.  
  447.  
  448.     def run(self):
  449.         #self.scan_active = True
  450.         self.format, self.format_name, self.last_frame, self.pixels_per_line, \
  451.             self.lines, self.depth, self.bytes_per_line = self.dev.getParameters()
  452.             
  453.         log.debug("format=%d" % self.format)
  454.         log.debug("format_name=%s" % self.format_name)
  455.         log.debug("last_frame=%d" % self.last_frame)
  456.         log.debug("ppl=%d" % self.pixels_per_line)
  457.         log.debug("lines=%d" % self.lines)
  458.         log.debug("depth=%d" % self.depth)
  459.         log.debug("bpl=%d" % self.bytes_per_line)
  460.         log.debug("byte_format=%s" % self.byte_format)
  461.             
  462.         w = self.buffer.write
  463.         
  464.         if self.format == scanext.FRAME_RGB: # "Color"
  465.             if self.depth == 8: # 8 bpp (32bit)
  466.                 self.pad_bytes = self.bytes_per_line - 3 * self.pixels_per_line
  467.                 
  468.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  469.                 
  470.                 dir = -1
  471.                 if self.byte_format == 'RGBA':
  472.                     dir = 1
  473.                 
  474.                 try:
  475.                     st, t = self.dev.readScan(self.bytes_per_line)
  476.                 except scanext.error, st:
  477.                     self.updateQueue(st, 0)
  478.                 
  479.                 #print st
  480.                 while st == scanext.SANE_STATUS_GOOD:
  481.                     
  482.                     if t:
  483.                         index = 0
  484.                         while index < len(t) - self.pad_bytes:
  485.                             w(t[index:index+3:dir])
  486.                             w('\xff')
  487.                             index += 3
  488.             
  489.                         self.total_read += len(t)
  490.                         self.updateQueue(st, self.total_read)
  491.                         log.debug("Read %d bytes" % self.total_read)
  492.                     
  493.                     else:
  494.                         time.sleep(0.1)
  495.                     
  496.                     try:
  497.                         st, t = self.dev.readScan(self.bytes_per_line)
  498.                     except scanext.error, st:
  499.                         self.updateQueue(st, self.total_read)
  500.                         break
  501.                     
  502.                     if self.checkCancel():
  503.                         break
  504.         
  505.         elif self.format == scanext.FRAME_GRAY: 
  506.         
  507.             if self.depth == 1: # 1 bpp lineart
  508.                 self.pad_bytes = self.bytes_per_line - (self.pixels_per_line + 7) // 8;
  509.                 
  510.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  511.                 
  512.                 try:
  513.                     st, t = self.dev.readScan(self.bytes_per_line)
  514.                 except scanext.error, st:
  515.                     self.updateQueue(st, 0)
  516.                
  517.                 while st == scanext.SANE_STATUS_GOOD:
  518.                     
  519.                     if t:
  520.                         index = 0
  521.                         while index < len(t) - self.pad_bytes:
  522.                             k = 0x80
  523.                             j = ord(t[index])
  524.                             
  525.                             for b in range(8):
  526.                                 if k & j:
  527.                                     w("\x00\x00\x00\xff")
  528.                                 else:
  529.                                     w("\xff\xff\xff\xff")
  530.                                 
  531.                                 k = k >> 1
  532.                             
  533.                             index += 1
  534.                     
  535.                         self.total_read += len(t)
  536.                         self.updateQueue(st, self.total_read)
  537.                         log.debug("Read %d bytes" % self.total_read)
  538.                     else:
  539.                         time.sleep(0.1)
  540.                         
  541.                     try:
  542.                         st, t = self.dev.readScan(self.bytes_per_line)
  543.                     except scanext.error, st:
  544.                         self.updateQueue(st, self.total_read)
  545.                         break
  546.                 
  547.                     if self.checkCancel():
  548.                         break
  549.                     
  550.             elif self.depth == 8: # 8 bpp grayscale
  551.                 self.pad_bytes = self.bytes_per_line - self.pixels_per_line
  552.                 
  553.                 log.debug("pad_bytes=%d" % self.pad_bytes)
  554.                 
  555.                 try:
  556.                     st, t = self.dev.readScan(self.bytes_per_line)
  557.                 except scanext.error, st:
  558.                     self.updateQueue(st, 0)
  559.                 
  560.                 while st == scanext.SANE_STATUS_GOOD:
  561.                     
  562.                     if t:
  563.                         index = 0
  564.                         while index < len(t) - self.pad_bytes:
  565.                             j = t[index]
  566.                             w(j)
  567.                             w(j)
  568.                             w(j)
  569.                             w("\xff")
  570.                             
  571.                             index += 1
  572.                     
  573.                         self.total_read += len(t)
  574.                         self.updateQueue(st, self.total_read)
  575.                         log.debug("Read %d bytes" % self.total_read)
  576.                     else:
  577.                         time.sleep(0.1)
  578.                         
  579.                     try:
  580.                         st, t = self.dev.readScan(self.bytes_per_line)
  581.                     except scanext.error, st:
  582.                         self.updateQueue(st, self.total_read)
  583.                         break
  584.                     
  585.                     if self.checkCancel():
  586.                         break
  587.                     
  588.         #self.dev.cancelScan()
  589.         self.buffer.seek(0)
  590.         self.scan_active = False
  591.         log.debug("Scan thread exiting...")
  592.         
  593.         
  594.     def checkCancel(self):
  595.         canceled = False
  596.         while self.event_queue.qsize():
  597.             try:
  598.                 event = self.event_queue.get(0)
  599.                 if event == EVENT_SCAN_CANCELED:
  600.                     canceled = True
  601.                     log.debug("Cancel pressed!")
  602.                     self.dev.cancelScan()
  603.             
  604.             except Queue.Empty:
  605.                 break
  606.  
  607.         return canceled
  608.         
  609.  
  610.  
  611. def init():
  612.     return scanext.init()
  613.     
  614.     
  615. def deInit():
  616.     return scanext.deInit()
  617.     
  618.     
  619. def openDevice(dev):
  620.     "Open a device for scanning"
  621.     return ScanDevice(dev)
  622.     
  623.     
  624. def getDevices(local_only=0):
  625.     return scanext.getDevices(local_only)
  626.     
  627.     
  628.